home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / doom / quake1.zip / QPU12.ZIP / QPU.DOC < prev    next >
Text File  |  1996-09-07  |  8KB  |  236 lines
  1.            
  2.                           //==\\ /|==|\ /\  /\
  3.                           ││  ││ ││  ││ ││  ││  v1.2
  4.                           ││\\││ ││==|/ ││  ││  ────
  5.                           ││ \\│ ││     ││  ││  │ by Richard
  6.                           \\==\\─\/─────\\──//──│    Nichols
  7.                                  (c)1996
  8. QPU v1.2 Documentation
  9. ══════════════════════
  10.  
  11. Written by Richard Nichols. Intended for DOS viewing.
  12.  
  13. New since previous version:
  14. ---------------------------
  15.   Nothing much. Most notably, the program only needs registering
  16.   once. Before you have to register every time (not so cool).
  17.  
  18.   Start/End screens to cause guilt complex =). I also rewrote my
  19.   programming library so it will be much more stable now.
  20.  
  21. Contents
  22. ────────
  23.  
  24. [I]   - Copyright info.
  25. [II]  - License info.
  26. [III] - About Me.
  27.  
  28. [IV]  - What is QPU?
  29. [V]   - Features and requirements of QPU.
  30. [VI]  - Index of features
  31.           ■ Basic use
  32.           ■ F1 - Extract
  33.           ■ F2 - Extract all
  34.           ■ F3 - Remove
  35.           ■ F4 - Insert
  36.           ■ F5 - View/Play
  37.           ■ F6 - Pack Info
  38.           ■ F7 - Rebuild
  39.           ■ F8 - Rename
  40.  
  41. [VII]  - Hints/Tips/Tricks/Notes
  42. [VIII] - Planned for future versions
  43. [IX]   - Contact Info
  44.  
  45. I. Copyright Information.
  46. ─────────────────────────
  47.  
  48.   THIS PIECE OF SOFTWARE IS FREEWARE YOU MUST DISTRIBUTE IT FREE OF CHARGE.
  49.   I AM NOT AFFILIATED WITH ID SOFTWARE IN ANY WAY, DO NOT MAIL OR ANNOY
  50.   ID ABOUT THIS PROGRAM. CONSEQUENTLY THIS IS AN UNOFFICIAL QUAKE ADDON.
  51.   QUAKE IS THE PROPERTY OF ID SOFTWARE DO NOT INFRINGE THEIR COPYRIGHT.
  52.  
  53.   I TAKE NO RESPONSIBLITY WHATSOEVER FOR THE ACTIONS OF THIS PROGRAM IN
  54.   RELATION TO YOUR COMPUTER SOFTWARE OR HARDWARE OR YOU. IF THIS PROGRAM
  55.   CAUSES DETRIMENT IN ANY WAY THE RESPONSIBITY IS NOT MINE.
  56.  
  57.   BY USING THE PROGRAM (QPU) YOU AGREE TO THE ABOVE TERMS AND CONDITIONS.
  58.  
  59.  
  60. II. License Information.
  61. ────────────────────────
  62.  
  63.   You are permitted to use this piece of software free of charge under the
  64.   provision that you send me mail of some sort and tell me what you think
  65.   of this program and any possible improvements. Contact Info is at the end
  66.   of this document.
  67.  
  68.   You may distribute this program so long as you do so FREE OF CHARGE! If
  69.   you are a magazine cover CD/disk collator then mail me before including
  70.   this please. If you are selling this for a profit you do so totally
  71.   illegally and without consent.
  72.  
  73.  ( The above restrictions are waved concerning Walnut Creek CDROM )
  74.  
  75. III. About me.
  76. ──────────────
  77.  
  78.   Well I'm 16, in grade 11 and live Australia. In my spare time I play
  79.   games, do homework and a large amount of programming. I'm an avid DOOM
  80.   fanatic and I embrace QUAKE with gayous abandon!
  81.  
  82.   I like music also and my favourite bands are Rage Against the Machine,
  83.   Insurge, Metallica and Red Hot Chilli Peppers. My favourite song at the
  84.   moment is Metallica's "Until it Sleeps".
  85.  
  86.   I want to go to uni study comp sci and become a professional programmer
  87.   for a major software house. You can help by sending me a mail telling me
  88.   how great this software is!
  89.  
  90.  
  91. IV. What is QPU?
  92. ────────────────
  93.  
  94.    QPU is a utility for viewing and editing the pack file format which
  95.    id Software's great game QUAKE uses. With it you can rip out files,
  96.    insert your own or just browse what's there.
  97.  
  98.  
  99. V. Features and requirements of QPU.
  100. ────────────────────────────────────
  101.  
  102. QPU requires:
  103.  
  104.   ■ 286 or better
  105.   ■ 640k of base RAM (350k Free)
  106.   ■ VGA display
  107.   ■ A Sound Blaster is required for Sound.
  108.  
  109.   ■ Quake (SW version will crash if you try to edit it)
  110.  
  111. QPU can:
  112.  
  113.   ■ Play sounds & view graphics from the pack
  114.   ■ Insert and remove files from the pack
  115.   ■ Rename a file in the pack
  116.   ■ Extract one or all of the files from the pack w/ or w/o paths.
  117.   ■ Rebuild the whole pack and optimise
  118.   ■ Give detailed pack info
  119.  
  120. VI. Index of features.
  121. ──────────────────────
  122.   ■ Basic use
  123.  
  124.     - The index window can be controlled with the up and down arrow keys.
  125.       Page up and page down go up and down a page. Home goes to the top
  126.       of the file, and end goes to the bottom.
  127.       LEFT and RIGHT move the hotspot (red line) up and down. This indicates
  128.       the currently selected entry in the pack. ESC quits. F1-F7 selects
  129.       actions (see below).
  130.  
  131.   ■ F1-Extract
  132.  
  133.     - This is pretty simple. Just press F1 to have the currently high-
  134.       lighted file extracted to the current directory with the name of
  135.       the file in the make. It does not keep directory tree structure.
  136.  
  137.   ■ F2-Extract All
  138.  
  139.     - This is the function performed by most other pack programs. Use this
  140.       to extract ALL the files from the pack. You have the option of keep-
  141.       ing the directory tree from the pack or just dumping the whole lot
  142.       to the current path. The tree is created off of the current path.
  143.       This can take about 10-15 minutes on slower HDs.
  144.  
  145.   ■ F3-Remove
  146.  
  147.     - This deletes the currently selected file from the pack. It does not
  148.       come back so choose wisely. This does not free the space taken by the
  149.       file. You must rebuild to free it (see notes).
  150.  
  151.   ■ F4-Insert
  152.  
  153.     - Inserts a file of your choosing into the pack as the last entry. This
  154.       will ONLY work if the pack's directory is at the end of the file. If
  155.       your's isn't then choose REBUILD from the main menu.
  156.  
  157.   ■ F5-View/Play
  158.  
  159.     - Plays or views the currently highlighted file. Applicable files are:
  160.  
  161.         * WAV sounds. Autodetection of Sound Blaster occurs at start.
  162.         * LMP graphics. On VGA displays =)
  163.         * BIN text images. (endscreen)
  164.  
  165.       More types will be added in later versions.
  166.  
  167.   ■ F6-Info
  168.  
  169.     - This just gives a listing of all the pack stats. Pretty self-
  170.       explanitory.
  171.  
  172.   ■ F7-Rebuild
  173.  
  174.     - This will rebuild the ENTIRE pack file to another name. This removes
  175.       any loose space along the way and will structure the pack such that
  176.       the directory is at the end. This can take about 10 minutes on some
  177.       machines.
  178.  
  179.   ■ F8-Rename
  180.  
  181.     - This will rename the highlighted file to your choosing. This will
  182.       be written to the pack IMMEDIATELY so don't screw up k?
  183.  
  184. VII. Hints/Tips/Tricks/Notes.
  185. ─────────────────────────────
  186.  
  187. 1. QPU is a very disk dependant piece of software.
  188.    Rebuild and extract all particularly give your HD a fair whacking so
  189.    it is best to load SMARTDRV before doing something big. I benchmarked
  190.    SMARTDRV to give about a 500% increase in performance on a few
  191.    different machines. Use it!
  192.  
  193. 2. Some of the features are very powerful. If you have a already modified
  194.    pack file then it would be a good idea to MAKE A BACKUP. Remember its
  195.    not my fault or responsibilty if QPU screws up you pak or machine.
  196.  
  197. 3. The remove function does NOT delete the space taken by the file removed.
  198.    So if you delete 5 .bsp files then you'll still have about 7 meg of
  199.    spare space in the pack file. To recover the space you have to REBUILD
  200.    the pack. To find out exactly how much space can be freed press F6.
  201.  
  202. 4. If things go all screwy on your monitor then its because you are either
  203.    running under windows or more likely you have a weird video card. This
  204.    is because QPU uses direct screen writes and also modifies the DOS text
  205.    font. To get over this you must mail me and I'll compile you a version
  206.    without these features.
  207.  
  208. 5. If you're wondering why the Title screen still reads QPU v1.0 its
  209.    because I can't be bothered changing it.
  210.  
  211. VIII. Planned for future versions.
  212. ──────────────────────────────────
  213.  
  214.   The point is this: Is a pack editor particularly useful? You may only
  215.   need it once and it will only really be useful for people developing
  216.   editors etc. Therefore development of QPU has ceased. I may make a
  217.   Quake 3D editor, but then again I may not. We will see. Just lately I
  218.   have been REALLY busy so I really wouldn't have a clue.
  219.  
  220. IX. Contact Info.
  221. ─────────────────
  222.  
  223. Report bugs, register from these contacts:
  224.  
  225.     E-Mail: tiberius@mailhost.net
  226.     WWW   : www.bip.concept.se/user/rich/index.htm
  227.     Phone : +61-(0)79-286832
  228.  
  229.     Snail : 354 Philp Ave 
  230.     mail  : Nth Rockhampton
  231.           : Q 4701
  232.           : AUSTRALIA
  233.  
  234.  TMLI     : Ph +61-(0)79-276200
  235.  IntraNet : mail: richarn1@tmli.rccnet.au
  236.